Skip to content

fix spelling errors#1153

Open
noeyy-mino wants to merge 1 commit intoNVIDIA:mainfrom
noeyy-mino:fix/spelling-errors
Open

fix spelling errors#1153
noeyy-mino wants to merge 1 commit intoNVIDIA:mainfrom
noeyy-mino:fix/spelling-errors

Conversation

@noeyy-mino
Copy link
Copy Markdown
Contributor

@noeyy-mino noeyy-mino commented Apr 1, 2026

What does this PR do?

Type of change: documentation

Fix spelling errors in README.

Usage

Testing

N/A

Before your PR is "Ready for review"

Make sure you read and follow Contributor guidelines and your commits are signed (git commit -s -S).

Make sure you read and follow the Security Best Practices (e.g. avoiding hardcoded trust_remote_code=True, torch.load(..., weights_only=False), pickle, etc.).

  • Is this change backward compatible?: ✅ /
  • If you copied code from any other sources or added a new PIP dependency, did you follow guidance in CONTRIBUTING.md: ✅
  • Did you write any new necessary tests?: N/A
  • Did you update Changelog?: ✅

Additional Information

N/A

Summary by CodeRabbit

Release Notes

  • Documentation
    • Fixed spelling and grammar corrections throughout changelogs, guides, and example documentation to improve clarity and accuracy across setup instructions and feature descriptions.

Signed-off-by: noeyy-mino <174223378+noeyy-mino@users.noreply.github.com>
@noeyy-mino noeyy-mino requested review from a team as code owners April 1, 2026 02:55
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 1, 2026

📝 Walkthrough

Walkthrough

This PR contains spelling corrections and minor documentation wording improvements across changelog, guides, and example README and notebook files. No functional code changes are introduced.

Changes

Cohort / File(s) Summary
Spelling and Grammar Fixes
CHANGELOG.rst, docs/source/guides/7_nas.rst, examples/diffusers/README.md, examples/llm_qat/notebooks/QAT_QAD_Walkthrough.ipynb, examples/specdec_bench/README.md, examples/speculative_decoding/README.md
Corrected spelling and grammar across documentation: "heterogenous"→"heterogeneous", "re-use"→"reuse", "cahce"→"cache", "requirments"→"requirements", "dependancies"→"dependencies", "controled"→"controlled", "contrainer"→"container", "ontop of"→"on top of", "effciency"→"efficiency".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix spelling errors' accurately reflects the main purpose of the pull request, which consists entirely of spelling and grammar corrections across multiple documentation and changelog files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Security Anti-Patterns ✅ Passed Pull request contains only documentation and spelling corrections with no Python code changes to the modelopt package.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@noeyy-mino noeyy-mino requested review from kevalmorabia97 and removed request for realAsma and yeyu-nvidia April 1, 2026 02:56
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@examples/llm_qat/notebooks/QAT_QAD_Walkthrough.ipynb`:
- Line 41: Update the sentence string "This repo contains a
`examples/llm_qat/notebooks/requirements.txt` file that can be used to install
all required dependencies." to use correct article: replace "a" with "an" (or
optionally "the") so it reads "This repo contains an
`examples/llm_qat/notebooks/requirements.txt` file..." ensuring the exact quoted
string in the notebook cell is changed accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8c2944f0-df05-4b3d-b8f2-2676ec4ff916

📥 Commits

Reviewing files that changed from the base of the PR and between ada1e26 and 54a56e8.

📒 Files selected for processing (6)
  • CHANGELOG.rst
  • docs/source/guides/7_nas.rst
  • examples/diffusers/README.md
  • examples/llm_qat/notebooks/QAT_QAD_Walkthrough.ipynb
  • examples/specdec_bench/README.md
  • examples/speculative_decoding/README.md

"- jupyterlab\n",
"\n",
"This repo contains a `examples/llm_qat/notebooks/requirements.txt` file that can be used to install all required dependancies."
"This repo contains a `examples/llm_qat/notebooks/requirements.txt` file that can be used to install all required dependencies."
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Minor grammar tweak in dependency sentence.

At Line 41, “a examples/... file” should be “an examples/... file” (or “the examples/... file”).

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@examples/llm_qat/notebooks/QAT_QAD_Walkthrough.ipynb` at line 41, Update the
sentence string "This repo contains a
`examples/llm_qat/notebooks/requirements.txt` file that can be used to install
all required dependencies." to use correct article: replace "a" with "an" (or
optionally "the") so it reads "This repo contains an
`examples/llm_qat/notebooks/requirements.txt` file..." ensuring the exact quoted
string in the notebook cell is changed accordingly.

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.20%. Comparing base (2bad66c) to head (54a56e8).
⚠️ Report is 12 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1153      +/-   ##
==========================================
+ Coverage   70.16%   70.20%   +0.03%     
==========================================
  Files         230      230              
  Lines       26029    26080      +51     
==========================================
+ Hits        18264    18310      +46     
- Misses       7765     7770       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants